Docs: Clarify life cycle issue
authorMatthias Clasen <mclasen@redhat.com>
Wed, 11 May 2016 17:25:15 +0000 (13:25 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 11 May 2016 17:25:15 +0000 (13:25 -0400)
gtk_gesture_get_last_event() wasn't very clear about how long
it is safe to use the returned pointer.

gtk/gtkgesture.c

index 8eaa5187784fb4b18e5ff81a52dcac83cee6a4ef..8f92f1d69c42fd478eae675afaf62ae980bf6154 100644 (file)
@@ -1274,6 +1274,10 @@ gtk_gesture_get_last_updated_sequence (GtkGesture *gesture)
  *
  * Returns the last event that was processed for @sequence.
  *
+ * Note that the returned pointer is only valid as long as the @sequence
+ * is still interpreted by the @gesture. If in doubt, you should make
+ * a copy of the event.
+ *
  * Returns: (transfer none) (nullable): The last event from @sequence
  **/
 const GdkEvent *